Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Updates #3938

Merged
merged 8 commits into from
Aug 1, 2018
Merged

Documentation Updates #3938

merged 8 commits into from
Aug 1, 2018

Conversation

danielduan
Copy link
Member

Issue:
Our docs have some grammatical and stylistic problems in English. I fixed some and added a README for other contributors' reference.

Some main points:

  • Never say something is easy or simple in our docs. Nothing is ever easy for users when they are confused.
  • Provide code snippets whenever possible.
  • Explain why something works the way it does so users have context and future maintainers are empowered to make the correct architectural decision.

Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great stuff @danielduan!

@ndelangen ndelangen merged commit b147730 into master Aug 1, 2018
@ndelangen ndelangen deleted the dd/doc-updates branch August 1, 2018 05:08
- Without pronoun (good): `Users can also...`
* Don't use `we` to refer to Storybook, contributors, or Storybook users.
- Pronoun (bad): `We can create this component...`
- Without pronoun (good): `The component can be created...`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But this is passive voice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants